Zum Hauptinhalt springen

Einheit 10 — Credentials für den API-Zugriff

Was du nach dieser Einheit weißt: Du kennst alle Bestandteile eines vollständigen Zugangsdatensatzes für einen API-Zugriff und weißt wo jedes Element in der 42°OS-Konfiguration eingetragen wird.

Was "Credentials" umfasst​

"Credentials" bedeutet im Kontext von API-Integrationen mehr als nur Benutzername und Passwort. Ein vollständiger Zugangsdatensatz besteht aus:

  1. Wo ist das System? → Host, Port, Instanz
  2. Wie spreche ich es an? → Protokoll, API-Pfad, Version
  3. Wer bin ich? → Authentifizierungsverfahren und -daten

Bestandteil 1: Host​

Der Host ist die Adresse des Systems — entweder ein Hostname oder eine IP-Adresse.

api.example.com          → öffentlicher Hostname
192.168.2.50             → interne IP-Adresse
erp-server.firma.local   → interner Hostname (nur intern auflösbar)

Häufige Fehler:

  • Hostname mit http:// oder https:// angeben — nur der nackte Hostname gehört ins Host-Feld
  • Interne Hostnamen die von außen nicht auflösbar sind
  • IP-Adresse die sich geändert hat (Server umgezogen)

Bestandteil 2: Port​

Der Port gibt an auf welchem "Eingang" des Servers der Dienst wartet.

Standard-Ports (werden oft weggelassen weil implizit):

  • HTTPS: 443
  • HTTP: 80

Nicht-Standard-Ports (müssen explizit angegeben werden):

  • 8443 — häufig für interne HTTPS-Dienste
  • 8080 — häufig für interne HTTP-Dienste
  • 5432 — PostgreSQL
  • 1433 — Microsoft SQL Server

Im Post Agent: Port wird in die URL eingebaut: https://192.168.2.50:8443/api/v1/...

Bestandteil 3: Instanz / Tenant​

Manche Systeme (besonders ERP-Systeme wie SAP, Microsoft Dynamics) laufen als Multi-Instanz — mehrere logisch getrennte Umgebungen auf derselben Hardware:

https://erp.firma.de/PRODUKTION/api/...   → Produktiv-Instanz
https://erp.firma.de/TEST/api/...          → Test-Instanz
https://erp.firma.de/SCHULUNG/api/...      → Schulungs-Instanz

Der Instanzname ist Teil der URL. Mit den Zugangsdaten der Produktiv-Instanz kannst du oft nicht auf die Test-Instanz zugreifen.

Bei SaaS-Systemen heißt das oft Tenant-ID oder Organization-ID:

https://meinunternehmen.salesforce.com/...
https://api.hubapi.com/...?hapikey=...&portalId=12345

Bestandteil 4: API-Pfad und Version​

Manche Systeme haben die API nicht unter dem Root-Pfad, sondern unter einem spezifischen Unterpfad:

https://erp.firma.de/api/rest/v2/customers
                    ─────────── ──
                    API-Basispfad  Version

Dieser Basispfad ist Teil jeder URL und muss korrekt konfiguriert sein.

Bestandteil 5: Authentifizierungsdaten​

Je nach Verfahren (aus Einheit 4 — Authentifizierung):

API Key:

Header-Name: X-API-Key
Header-Wert: abc123secretkey

Basic Auth:

Benutzername: api_user
Passwort: geheimesPasswort

(Wird von 42°OS automatisch Base64-kodiert und als Authorization-Header gesetzt)

Bearer Token / OAuth 2.0:

Token-Endpunkt: https://auth.example.com/oauth/token
Client ID: meine_client_id
Client Secret: sehr_geheimes_secret
Scope: read:customers write:orders

Bestandteil 6: SSL-Zertifikat-Konfiguration​

Für interne Systeme mit selbstsignierten Zertifikaten:

SSL Verify: false          → Zertifikat wird nicht geprüft (nur intern!)
CA Certificate: [Inhalt]   → oder: das interne CA-Zertifikat explizit vertrauen

Der vollständige Zugangsdatensatz in der Praxis​

Ein typischer Zugangsdatensatz für ein On-Prem ERP:

{
  "host": "192.168.2.50",
  "port": 8443,
  "instance": "PRODUKTION",
  "base_path": "/api/rest/v2",
  "auth_type": "basic",
  "username": "42os_integration",
  "password": "...",
  "ssl_verify": false
}

Ein typischer Zugangsdatensatz für eine Cloud-API:

{
  "base_url": "https://api.salesforce.com",
  "auth_type": "oauth2",
  "token_endpoint": "https://login.salesforce.com/services/oauth2/token",
  "client_id": "...",
  "client_secret": "...",
  "scope": "api refresh_token"
}

Checkliste bei Verbindungsproblemen​

□ Host erreichbar? → ping oder curl vom richtigen Server
□ Port offen? → curl -v https://host:port/
□ DNS auflösbar? → nslookup hostname
□ Firewall-Freigabe vorhanden? → IT fragen
□ Richtige Instanz? → URL prüfen
□ Credentials korrekt? → manuell mit Postman testen
□ Token abgelaufen? → Bearer Token prüfen
□ SSL-Zertifikat gültig? → Browser-Warnung oder curl-Fehler
□ Richtiges Subnetz? → Von welcher IP kommt 42°OS?

Damit hast du das Infrastruktur-Wissen: Wo Systeme laufen, wie Netzwerke und Firewalls funktionieren, was VPN tut und welche Zugangsdaten du für eine API-Integration brauchst.

Weiter: Einheit 11 — API-Dokumentation lesen